DeepLink API Calls
Create OIDC Client
This call creates ClientID and secret for a given account Guid.
Authentication
This call requires Tenant Admin credentials or user having system management or user management role.
HTTP Method
POST
Request URI
api/v1/oidc/client
Request Parameters
Parameter |
Argument Type |
Description |
Example Value |
---|---|---|---|
accountGuid | Request Body | Account Guid of the client. | 1181cdec-f141-4de3-b71a-36fc26ab9a4a |
This API can be accessed with Basic mode of authentication as well as with the Token-based authentication.
Example Request with Access Token
curl --location --request POST 'https://host/api/v1/oidc/client' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer access_token' \
--data-raw '{
"accountGuid":"1181cdec-f141-4de3-b71a-36fc26ab9a4a"
}'
Example Request with Basic Auth
curl --location --request POST 'https://host/api/v1/oidc/client' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic dms2QGFwaS4yNzEwM2IudGVzdDEuY29tOlNoaXZhU2hpdmFTaGl2ddsdd=' \
--data-raw '{
"accountGuid":"f70b47b4-ebb9-4ecc-a4bb-a14923622d41"
}'
Sample Response
{"errors":null,
"result":{
"clientId":"CLIENT_ID ",
"clientSecret":"CLIENT_SECRET",
"accountGuid":"1181cdec-f141-4de3-b71a-36fc26ab9a4a"
}
}
DeepLink Login
This API fetches the one time login nonce token.
Authentication
This call requires Tenant Admin credentials or user having system management or user management role.
HTTP Method
POST
Request URI
api/v1/account/login-nonce
This API can be accessed with Basic mode of authentication as well as with the Token-based authentication.
Example Request with Access Token
curl --location --request POST 'https://host/api/v1/account/login-nonce' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer access_token'
Token Based Auth and Deep-link Login (TeamViewer & Neurons MDM).
Example Request with Basic Auth
curl --location --request POST 'https://host/api/v1/account/login-nonce' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic
dmtAYXBpLmI5NzZmMy50ZXN0MS5jb206U2hpdmFTaGl2YVNoaXZhBSBSB=='
Response
{ "errors": null, "result": { "loginNonce":
"7F7F00009C4BAFBE00010006001029572448BA511280D568957989F78AD3BEAF0B5843F996019CD054
CBE1B415A36B11BAFC2F42B0423E53199E2EFC54CCB9686D412BE989A20C07939B0386A3B35A5CE7F6
91E8210FF73048A69D521B85061891B494D680D9C7F66A9562256D50D688DB76073815E928D2081CBC
2A05503F60D9EE72CA2BD411CB948A43E8F47DE4745C12477516F0555332EF6DAA94388E2CA4FB79"
}
}
Reset Secret
This call resets the secret API for the OIDC client.
Authentication
This call requires Tenant Admin credentials.
HTTP Method
POST
Request URI
api/v1/oidc/secret-reset
Request Parameters
Parameter |
Argument Type |
Description |
Example Value |
---|---|---|---|
accountGuid | Request Body | Account id of the client. | 1181cdec-f141-4de3-b71a-36fc26ab9a4a |
Example Request
'https://host/api/v1/oidc/secret-reset' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer access_token' \
--data-raw '{
"accountGuid":"1181cdec-f141-4de3-b71a-36fc26ab9a4a"
}'
Sample Response
{
"errors": null,
"result": {
"clientId": "CLIENT_ID",
"clientSecret": "CLIENT_SECRET",
"accountGuid": "1181cdec-f141-4de3-b71a-36fc26ab9a4a"
}
}